HyperLib 1997 Winter

home *** CD-ROM | disk | FTP | other *** search

/ HyperLib 1997 Winter - Disc 1 / HYPERLIB-1997-Winter-CD1.ISO.7z / HYPERLIB-1997-Winter-CD1.ISO / オンラインウェア / PRG / nShell-Pro.sit / nShell-Pro / doc / nShell™ Command Reference.rsrc / TEXT_128.txt < prev next >

Wrap

Text File | 1994-12-28 | 28KB | 1,389 lines

A Command Reference for nShell邃｢ and nShell-Pro邃｢ Version 1.5.0 Copyright ﾂｩ 1994 Newport Software Development P.O. Box 1485 Newport Beach, CA 92659 Technical Support Technical support is available by electronic mail. You may contact John Jensen at any of the following addresses: jjensen@kaiwan.com jjensen@aol.com jjens@eworld.com Introduction The following pages describe the commands available within the nShell(tm) environment. For the most part, these descriptions are copies of the "man pages" from the commands themselves. Man pages provide on-line help within the nShell system. Each description contains the following information about a command: NAME - is the command name SYNOPSIS - is a grammatical description DESCRIPTION - is an longhand verbal description These may be followed by one or more of these optional headings: OPTIONS - are the available options for the command RETURN CODES - are special purpose return codes SEE ALSO - refers the reader to other related topics BUGS - is the list of currently known bugs EXAMPLES - examples of command usage OTHERS - is any other topics not included above For more information see the entry for the "man" command. For information about creating your own man pages, see the nShell Programmer's Guide. Commands The following are man pages for nShell邃｢ commands: .eq. .eq. - Is parameter1 EQUAL TO parameter2? SYNOPSIS .eq. parameter1 parameter2 DESCRIPTION If both parameters are legal integers, an integer comparison is performed. If either parameter is not an integer, a string comparison is performed. These comparison commands may be used to test the return value from a previous command. It is important to note, however, that the comparison itself produces a return value and will overwrite "$?". For this reason, the return code should be saved into a temporary variable before a series of comparisons are performed: command_x set temp $? # save the result if .lt. $temp 0 then echo "A serious error has occurred." endif if .eq. $temp 0 then echo "Everything is ok" endif if .gt. $temp 0 then echo "command_x returned a value of" $temp endif RETURN CODES <0 Error 0 True 1 False SEE ALSO .ge. .gt. .le. .lt. .ne. .ge. .ge. - Is parameter1 GREATER THAN OR EQUAL TO parameter2? SYNOPSIS .ge. parameter1 parameter2 DESCRIPTION If both parameters are legal integers, an integer comparison is performed. If either parameter is not an integer, a string comparison is performed. RETURN CODES <0 Error 0 True 1 False SEE ALSO .eq. .gt. .le. .lt. .ne. .gt. .gt. - Is parameter1 GREATER THAN parameter2? SYNOPSIS .gt. parameter1 parameter2 DESCRIPTION If both parameters are legal integers, an integer comparison is performed. If either parameter is not an integer, a string comparison is performed. RETURN CODES <0 Error 0 True 1 False SEE ALSO .eq. .ge. .le. .lt. .ne. .le. .le. - Is parameter1 LESS THAN OR EQUAL TO parameter2? SYNOPSIS .le. parameter1 parameter2 DESCRIPTION If both parameters are legal integers, an integer comparison is performed. If either parameter is not an integer, a string comparison is performed. RETURN CODES <0 Error 0 True 1 False SEE ALSO .eq. .ge. .gt. .lt. .ne. .lt. .lt. - Is parameter1 LESS THAN parameter2? SYNOPSIS .lt. parameter1 parameter2 DESCRIPTION If both parameters are legal integers, an integer comparison is performed. If either parameter is not an integer, a string comparison is performed. RETURN CODES <0 Error 0 True 1 False SEE ALSO .eq. .ge. .gt. .le. .ne. .ne. .ne. - Is parameter1 NOT EQUAL TO parameter2? SYNOPSIS .ne. parameter1 parameter2 DESCRIPTION If both parameters are legal integers, an integer comparison is performed. If either parameter is not an integer, a string comparison is performed. RETURN CODES <0 Error 0 True 1 False SEE ALSO .eq. .ge. .gt. .le. .lt. ask ask - pop a three button modal dialog SYNOPSIS ask [-s | -m | -l] [strings...] DESCRIPTION The "ask" command displays a dialog and waits for the user to press one of three buttons. The string parameters are concatenated within the dialog and are limited to a total of 255 characters. If no strings are given on the command line, standard input is used. The three buttons are: "yes", "no" and "cancel". OPTIONS -s Display a small dialog -m Display a medium dialog (default) -l Display a large dialog RETURN CODES <0 Error 1 For "yes" 2 For "no" 3 For "cancel" SEE ALSO notify BUGS Strings may overrun the dialog size. battery battery - display battery status SYNOPSIS battery DESCRIPTION This command uses the BatteryStatus system call. The current battery voltage and charger status are displayed. Conditions which may be displayed are: The charger is [dis]connected. The charger has recently been [dis]connected. The low voltage flag is set. The high charging rate flag is set. RETURN CODES <0 Battery status could not be read. 0 Success Note: Battery status information is only available on systems in which the Power Manager is installed. beep beep - make a beep sound SYNOPSIS beep DESCRIPTION This command calls the OSUtils SysBeep routine. RETURN CODES <0 Error 0 Success cat cat - copy to standard output SYNOPSIS cat [file1] [file2] . . . DESCRIPTION This command copies each of the specified files to standard output. RETURN CODES <0 Error 0 Success cd cd - change working directory SYNOPSIS cd "this:is:my new:path" DESCRIPTION The "cd" command allows the user to specify a new working directory. The working directory is held in the $PWD shell variable. If a partial pathname is given, a full path is generated using the existing $PWD variable. If no pathname is given, the user is returned to the $HOME directory. Pathnames consist of volume and directory names separated by ':' characters. Pathnames may be "quoted", and must be when a volume or directory name contains a space. SEE ALSO pwd chattr chattr - change attributes SYNOPSIS chattr file [file2...] [-c crea] [-t type] DESCRIPTION A file's "type" and "creator" are used to track what kind of data is in a file, and what application the file belongs to. The "chattr" command may be used to display or change these file attributes. When "chattr" is followed by one or more file names, a table of file creators and types will be displayed. The -c and -t options may be used to change the file attributes. OPTIONS -c abcd Change file creator to 'abcd' -t abcd Change file type to 'abcd' RETURN CODES <0 Error 0 Success cp cp - copy files SYNOPSIS cp source target cp source [source2...] target DESCRIPTION The "cp" command copies files. This command may be used to copy one or more files to a target path. When one source file is specified, the destination may be a file or a directory. When more than one source file is specified, the target must be a directory. RETURN CODES <0 Error 0 Success date date - display system time SYNOPSIS date [-dmas] DESCRIPTION The "date" command uses the International Utilities Package to format a date and time string for display on standard output. OPTIONS -d Date only, the time is not printed. -m Minutes only, seconds are not printed. -a Abbreviated date format is used. -s Short date format is used. RETURN CODES <0 Error 0 Success SEE ALSO try "man date examples" dec dec - Decrement a variable SYNOPSIS dec variable [offset] DESCRIPTION This command will subtract an offset from a numeric variable: variable = variable - offset RETURN CODES <0 Error 0 The result of the decrement is greater than zero. 1 The result of the decrement is less than or equal to zero. delay delay - wait a specified amount of time SYNOPSIS delay [-m] delay_time DESCRIPTION The delay command will suspend shell operation for the specified length of time. This command halts the current shell only. All other shells and applications will continue to run. The delay_time is assumed to be specified in seconds, unless the -m option is used. OPTIONS -m The delay time is specified in minutes. RETURN CODES <0 Error 0 Success df df - report free disk space on volumes SYNOPSIS df [volume_name...] DESCRIPTION This command displays the size of currently mounted volumes, the amount of used and available space, and how much of the volume's total capacity have been used. When no arguments are given, df reports on all mounted volumes, producing something like this: filesystem kbytes used avail capacity new boy 157940 91298 66642 57% dog boy 156917 105357 51560 67% RETURN CODES <0 Error 0 Success du du - disk usage SYNOPSIS du [-a | -s] [pathname...] DESCRIPTION The "du" command displays disk usage for files and directories. Sizes are given as the physical storage occupied by each file, in K (1024 bytes). The physical size of a file is determined in part by the allocation block size of the disk on which it resides. To see the actual or "logical" size of a file, use the ls command with a -l option. OPTIONS -a generate an entry for each file -s display a grand total for each path only RETURN CODES <0 Error 0 Success echo echo - repeat a string SYNOPSIS echo [string...] DESCRIPTION The "echo" command displays a string parameter on standard output. If more than one string parameter is given they are concatenated. The combined string may not exceed 255 characters. RETURN CODES <0 Error 0 Success env env - list shell variables SYNOPSIS env [name1] [name2] . . . DESCRIPTION The "env" command will list the current shell environment. Variables are listed with their values. If no parameters are given, all active shell variables are listed. Variable names are limited to the characters a-z, A-Z, 0-9, _ and may be 31 characters in length. RETURN CODES <0 An error prevented the search 0 Successful search (inc. name not found) SEE ALSO set, unset exit exit - exit script SYNOPSIS exit [return code] DESCRIPTION The "exit" command causes an immediate return from a script. An integer return code may be set and later accessed using the $? pseudo variable. When no parameter is given, a code of 0 is returned. When the "exit" command is used on the command line, it cancels all processing and sets the specified return code. EXAMPLES # # test usage # if .ne. $# 2 then echo "Usage: cmd filename" exit -1 endif export export - export a shell variable from a script SYNOPSIS export variable_name DESCRIPTION The "export" command copies a shell variable from the current script environment to that of the parent. The "export" operation copies variables up a single level. To export variables from nested scripts, a series of "export" commands would be required. The "export" command should only be used from within scripts, and fails when typed directly on the command line. EXAMPLES # # set the working directory and export the corresponding variable # cd "my disk:my favorite tools:tools" export PWD find find - search for files SYNOPSIS find pathname [pathname...] [-name 'pattern'] [-o] [-type 'type'] [-a] [-creator 'crea'] DESCRIPTION Search all directories below a given pathname for matching files. The search options allow logical expressions to be developed. For example, the following command will search "my_path" for all files who's names start with "sample" or "demo". find my_path -name '[sS]ample*' -o -name '[dD]emo*' If no relation between expressions is defined, an implied "and" is used. OPTIONS -name 'pattern' The match is true if the name matches the given pattern. -o The match is successful if the previous condition is true. -type 'type' The match is true if the file is of the given type. -a The match fails if the previous condition is false. -creator 'crea' The match is true if the file has the given creator. RETURN CODES <0 Error 0 Success fss fss - display file system specification (FSSpec) SYNOPSIS fss pathname [pathname...] DESCRIPTION The "fss" command will display the file system specification (FSSpec) for each file or folder listed on the command line. The FSSpec is a record that identifies a stored file or directory within the Macintosh file system. It consists of three parts: volume reference number, parent directory ID, and name. RETURN CODES <0 Error 0 Success gestalt gestalt - display system gestalt information SYNOPSIS gestalt [-d] OSType [OSType...] DESCRIPTION This command displays response codes from the system Gestalt call. This call is used to test the version or availability of system resources. As an example, the command "gestalt sysv" will display the version of your system software. The OSType selectors must be specified as four character strings, as in sysv or "os ". Quotes are required when the selectors contain spaces. The return codes are displayed as hexadecimal values, unless a -d option is specified. OPTIONS -d Display the response codes in decimal. RETURN CODES <0 Error 0 Success grep grep - type matching lines to standard output SYNOPSIS grep [-e] 'pattern' [file...] DESCRIPTION The grep utility shall search the input files, selecting lines matching patterns. An input line shall be selected if the pattern, treated as a Regular Expression, matches any part of that line. RETURN CODES <0 Error 0 Pattern found at least once 1 Pattern not found SEE ALSO match head head - copy the first part of files SYNOPSIS head [-n number] [file1] [file2] . . . DESCRIPTION The "head" command copies the first "n" lines of a file. If no option is given, a default of ten lines are copied. Note: "lines" are defined as carriage returns. A line may wrap several times in your shell window, but still be counted as a single line. RETURN CODES <0 Error 0 Success SEE ALSO tail hello hello - a minimal command SYNOPSIS hello DESCRIPTION The "hello" command is included as a minimal example of an nShell(tm) command. Source code for this command is discussed in the nShell Programmers' Guide. RETURN CODES <0 Error 0 Success inc inc - Increment a variable SYNOPSIS inc variable [offset] DESCRIPTION This command will add an offset to a numeric variable: variable = variable + offset RETURN CODES <0 Error 0 Success if if - conditional execution SYNOPSIS if <commands1> then <commands2> [else <commands3>] endif DESCRIPTION If the result of the last command of the set <commands1> completes without error (result = zero), then the <commands2> clause will be executed. If the result of the last command of the set <commands1> produces an error (result <> zero), and an else-clause is present, that clause will execute. Flow of control statements are available in nShell-Pro(tm) RETURN CODES <0 Error 0 Success SEE ALSO while, until EXAMPLES if yesno "Should I say hello?" then hello endif launch launch - start an application SYNOPSIS launch application_path [document_path] DESCRIPTION This command will launch a specified application. If a document is specified, it will be opened when the application is launched. This command requires System 7. RETURN CODES <0 Error 0 Success lock lock - lock files SYNOPSIS lock file [file...] DESCRIPTION This command may be used to change the "Locked" flag for files and folders. This is the same "Locked" flag which is visible within the Finder's Get Info box. When the "Locked" flag is set, files may not be modified, their names may not be changed, and they may not be deleted. Note: The "Locked" flags for folders may not be changed in some versions of the Mac OS. In these versions an error message will be displayed. RETURN CODES <0 Error 0 Success ls ls - list directory contents SYNOPSIS ls [[-c cols] | [-l [-g] [-b]]] [pathname] DESCRIPTION The "ls" command is included as a method of listing directory contents. OPTIONS -c list the directory contents in the specified number of columns. -l long listing -g specifies file creation dates on long listings -b specifies file backup dates on long listings RETURN CODES <0 Error 0 Success man man - command line manual SYNOPSIS man command [section] DESCRIPTION The "man" program reads a descriptive text resource from within a selected command and writes that text to standard output. Note: Man pages are available for flow-of-control statements, but they must be quoted so that the shell knows how to execute them: man "if" man "while" RETURN CODES <0 Error 0 Success SEE ALSO try "man man resources" The nShell Programmer's Guide contains additional information on writing man resources. match match - type matching lines to standard output SYNOPSIS match -p 'pattern' [file...] DESCRIPTION This is a grep-like command. Patterns are specified in shell-sytle wildcards, so a pattern of: yak - will match all lines containing "yak" foo*bar - will match lines containing "foo" followed by "bar". [a-c]oo - will match lines containing "aoo", "boo" or "coo". NOTE: It is important to put single quotes around patterns containing wildcards, so that the shell will not match them with file names. RETURN CODES <0 Error 0 Success mem mem - show free memory SYNOPSIS mem DESCRIPTION The "mem" command prints the free space in the current heap zone on standard output. RETURN CODES <0 Error 0 Success mkdir mkdir - create directories SYNOPSIS mkdir dir [dir2...] DESCRIPTION The "mkdir" command creates directories. Full or partial pathnames may be used to specify the new directories. RETURN CODES <0 Error 0 Success mv mv - move files SYNOPSIS mv source target mv source [source2...] target DESCRIPTION The "mv" command moves files. This command may be used to move one or more files to a target path. When one source file is specified, the destination may be a file or a directory. When more than one source file is specified, the target must be a directory. RETURN CODES <0 Error 0 Success notify notify - pop an informational dialog SYNOPSIS notify [-s | -m | -l] [strings...] DESCRIPTION The "notify" command displays a dialog and waits for the user to press an acknowledgement button. The string parameters are concatenated within the dialog and are limited to a total of 255 characters. If no strings are given on the command line, standard input is used. RETURN CODES <0 Error 0 Success SEE ALSO ask BUGS Strings may overrun the dialog size. odoc odoc - open a document SYNOPSIS odoc document_path [application_path] DESCRIPTION This command will open a specified document. If an application is specified, a message will be sent to that application to open the document. If no application is specified, the document's creator will be used. This command requires System 7. RETURN CODES <0 Error 0 Success path path - define a command search path SYNOPSIS path "this:is:path:one/this:is:path:two" DESCRIPTION The "path" command allows the user to specify a command search path. The path is stored in the $PATH shell variable. Directories are separated by ":", and paths are separated by "/". A single ":" may be used to specify the current directory, as in "path :/this:is:path:two" . Any variables used in the path are evaluated when you issue the path command. In the command "path $HOME:bin", the value of $HOME is evaluated immediately. If you change the value of $HOME later, the path will continue to point to the original :bin directory. The default path is ":/$HOME:bin". RETURN CODES <0 Error 0 Success SEE ALSO which pathchk pathchk - evaluates a full or partial pathname SYNOPSIS pathchk pathname DESCRIPTION The nShell environment uses traditional Macintosh pathnames. The "pathchk" command is included to allow the user to experiment with those pathnames. Given a full or partial pathname, pathchk will echo the equivalent full pathname. Pathchk does not check to see if any of the specified volumes, directories, or files exist. RETURN CODES <0 Error 0 Success SEE ALSO which ps ps - process status information SYNOPSIS ps DESCRIPTION The "ps" command lists information from the Process Manager. This information includes the I.D., the Creator and Type, and the memory usage for each process. RETURN CODES <0 Error 0 Success pwd pwd - print working directory SYNOPSIS pwd DESCRIPTION The "pwd" command prints the full path of the current working directory. The working directory is stored in the $PWD shell variable. RETURN CODES <0 Error 0 Success SEE ALSO cd read read - read input and store in shell variables SYNOPSIS read variable [variable...] DESCRIPTION This command collects input strings and stores them in shell variables. If more than one variable is used, the first word of input will go in the first variable, and so on. All remaining characters will go in the last variable listed. Quoted strings are considered to be a single "word", and will go together into a shell variable. This routine collects data from a single line, and terminates when a ^D or Return is encountered. RETURN CODES <0 Error 0 Variables were filled 1 ^D was encountered before any data rm rm - remove files SYNOPSIS rm file [file2...] DESCRIPTION The "rm" command will delete each file in a list. Missing files are skipped. If a directory is specified as a parameter to "rm", it is skipped as well. RETURN CODES <0 Error 0 Success rmdir rmdir - remove directories SYNOPSIS rmdir dir [dir2...] DESCRIPTION The "rmdir" will delete each directory in a list. Missing directories are skipped. If a file is specified as a parameter to "rm", it is skipped as well. Directories must be empty to be deleted. RETURN CODES <0 Error 0 Success set set - set environmental variables SYNOPSIS set name [value] DESCRIPTION The "set" command allows the operator to set variables within the shell environment. The normal syntax includes a "value" string. If no value is given, the shell variable is set equal to a null string. Variable names are limited to the characters a-z, A-Z, 0-9, _ and may be 31 characters in length. The value string may contain any character and may be 255 characters in length. RETURN CODES <0 An error prevented the assignment 0 Successful assignment SEE ALSO unset, env sfget sfget - pop a standard file dialog SYNOPSIS sfget <variable name> [ -p "prompt string" ] DESCRIPTION The "sfget" command displays a dialog and waits for the user to select a file or folder. The path to the selected item is returned as a shell variable. RETURN CODES <0 Error 0 Success 1 Canceled by User SEE ALSO ask, notify, sfput sfput sfput - pop a standard file dialog SYNOPSIS sfput <variable name> [ -p "prompt string" ] DESCRIPTION The "sfput" command displays a dialog and waits for the user to enter a name for a new file or folder. The path to the selected item is returned as a shell variable. RETURN CODES <0 Error 0 Success 1 Canceled by User SEE ALSO ask, notify, sfget shift shift - Shift numeric variables SYNOPSIS shift [n] DESCRIPTION The numeric variables shall be shifted. Numeric variable $0 shall be assigned the value of variable $(0+n), variable $1 shall be assigned the value of variable $(1+n), and so forth. The variables represented by the numbers $# down to $#-n+1 shall be unset, and the variable $# shall be updated to reflect the new number of variable variables. RETURN CODES <0 Error 0 Success, $0 is valid. 1 No numeric variables found, $0 is cleared. tail tail - copy the last part of files SYNOPSIS tail [-n number] [file1] [file2] . . . DESCRIPTION The "tail" command copies the last "n" lines of a file. If no option is given, a default of ten lines are copied. Note: "lines" are defined as carriage returns. A line may wrap several times in your shell window, but still be counted as a single line. RETURN CODES <0 Error 0 Success SEE ALSO head unlock unlock - unlock files SYNOPSIS unlock file [file...] DESCRIPTION This command may be used to change the "Locked" flag for files and folders. This is the same "Locked" flag which is visible within the Finder's Get Info box. When the "Locked" flag is set, files may not be modified, their names may not be changed, and they may not be deleted. Note: The "Locked" flags for folders may not be changed in some versions of the Mac OS. In these versions an error message will be displayed. RETURN CODES <0 Error 0 Success unset unset - remove a shell variable SYNOPSIS unset name DESCRIPTION The "unset" command removes the named variable from the shell environment. Variable names are limited to the characters a-z, A-Z, 0-9, _ and may be 31 characters in length. RETURN CODES <0 An error prevented the removal 0 Successful removal or name not found SEE ALSO set, env until until - conditional execution SYNOPSIS until <commands1> do <commands2> done DESCRIPTION In this structure, the <commands1> clause will always execute. If the result of the last command of the set produces an error (result <> zero), then the <commands2> clause will be executed. Control will then return to the <commands1> clause, and the process will continue until the last command of this set completes without error (result = 0). Flow of control statements are available in nShell-Pro(tm) RETURN CODES <0 Error 0 Success SEE ALSO while, if EXAMPLES until yesno "Should I STOP saying hello?" do hello done wc wc - display a count of lines, words and characters SYNOPSIS wc [-l] [-w] [-c] [filename...] DESCRIPTION The "wc" command counts lines, words, and characters in files, or in the standard input if no filename appears. It also keeps a total count for all named files. A word is a string of characters delimited by SPACE, TAB, or NEWLINE characters. OPTIONS -l display line count -w display word count -c display character count The default for this command is -lwc, displaying all counts. If any options are specified, only those counts will be displayed. EXAMPLES % wc *.txt 1 2 12 cat.txt 4 12 60 dog.txt 5 14 72 total % wc *.txt -lw 1 2 cat.txt 4 12 dog.txt 5 14 total which which - which copy of a command will be used SYNOPSIS which command DESCRIPTION "which" examines the command-search-path, and returns the location of the command which would be executed. The which command first checks to see if the specified command is internal to the nShell application. Each directory in the search path is then examined to see if it contains an external command or shell script of the given name. Any 'TEXT' file with a matching name is assumed to be a shell script. RETURN CODES <0 Error or command not found 0 Success SEE ALSO path, pathchk while while - conditional execution SYNOPSIS while <commands1> do <commands2> done DESCRIPTION In this structure, the <commands1> clause will always execute. If the result of the last command of the set completes without error (result = zero), then the <commands2> clause will be executed. Control will then return to the <commands1> clause, and the process will continue until the last command of this set produces an error (result <> 0). Flow of control statements are available in nShell-Pro(tm) RETURN CODES <0 Error 0 Success SEE ALSO until, if EXAMPLES while yesno "Should I say hello?" do hello done yesno yesno - ask a yes or no question SYNOPSIS yesno [-i] [string...] DESCRIPTION This command prompts the user for a 窶忱窶 or 窶從窶 response. The string parameters are concatenated and may not exceed a total of 255 characters. If the -i option is used the prompt is read from standard input. OPTIONS -i Read the prompt from standard input RETURN CODES <0 Error 0 The user selected 窶忱窶 or 窶弸窶 1 The user selected 窶從窶 or 窶廸窶 EXAMPLES % yesno (y/n): y % % yesno 窶廬s this right窶 Is this right (y/n): y %